Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: braze sdk metadata #1949

Merged
merged 3 commits into from
Jan 6, 2025
Merged

feat: braze sdk metadata #1949

merged 3 commits into from
Jan 6, 2025

Conversation

davidbielik
Copy link
Contributor

@davidbielik davidbielik commented Nov 26, 2024 •
edited
Loading

Adds SDK Metadata observability

We use this for feature/maintenance prioritization on Braze SDKs.

Please confirm you have tested for the following browsers:

  • Chrome
  • Firefox
  • IE11

Sanity Suite

  • All sanity suite test cases pass locally

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Summary by CodeRabbit

  • New Features

    • Enhanced Braze SDK integration with additional metadata for improved tracking and logging capabilities.

  • Bug Fixes

    • No bug fixes were introduced in this release.

  • Documentation

    • No changes to documentation were made.

@davidbielik davidbielik requested a review from a team as a code owner November 26, 2024 19:25
@contributor-support
Copy link

Thank you @davidbielik for contributing this PR.
Please sign the Contributor License Agreement (CLA) before merging.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 26, 2024 •
edited
Loading

📝 Walkthrough

Walkthrough

The changes in this pull request involve the addition of a new line in the init method of the Braze class within the browser.js file. This line integrates SDK metadata into the Braze initialization process without altering the existing functionality of the class. The methods for user identification, event tracking, and session management remain unchanged, ensuring that the overall control flow and logic of the class are preserved.

Changes

File Path Change Summary
packages/analytics-js-integrations/src/integrations/Braze/browser.js Added a line in the init method to include SDK metadata for enhanced tracking/logging capabilities.

Possibly related PRs

  • fix: userId in braze hyrbrid #1835: This PR modifies the identify method in the Braze class, which is directly related to the changes made in the main PR that adds SDK metadata in the init method of the same class.

Suggested reviewers

  • Gauravudia
  • utsabc
  • sanpj2292
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 134d779 and e45d58f.

📒 Files selected for processing (1)
  • packages/analytics-js-integrations/src/integrations/Braze/browser.js (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/analytics-js-integrations/src/integrations/Braze/browser.js

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codecov Codecov
Copy link

codecov bot commented Dec 9, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.27%. Comparing base (57e977d) to head (97c90e9).
Report is 1 commits behind head on develop.

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop    #1949   +/-   ##
========================================
  Coverage    61.27%   61.27%           
========================================
  Files          484      484           
  Lines        16615    16616    +1     
  Branches      3329     3329           
========================================
+ Hits         10181    10182    +1     
  Misses        5243     5243           
  Partials      1191     1191

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions GitHub Actions
Copy link

Hello! This PR has been open for 20 days without any activity. Therefore, it's considered as stale and is scheduled to be closed in 10 days. If you're still working on this, please remove the 'Stale' label or add a comment to keep it open. Thanks for your contribution!

@github-actions github-actions bot added the Stale label Dec 30, 2024
@utsabc utsabc changed the title [Braze] SDK Metadata feat: Braze SDK Metadata Jan 6, 2025
@utsabc utsabc changed the title feat: Braze SDK Metadata feat: braze sdk metadata Jan 6, 2025
@saikumarrs saikumarrs merged commit 81fe85a into rudderlabs:develop Jan 6, 2025
8 of 11 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jan 7, 2025
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

@saikumarrs saikumarrs saikumarrs approved these changes

@utsabc utsabc utsabc approved these changes

@sanpj2292 sanpj2292 Awaiting requested review from sanpj2292 sanpj2292 is a code owner automatically assigned from rudderlabs/integrations

@chandumlg chandumlg Awaiting requested review from chandumlg chandumlg is a code owner automatically assigned from rudderlabs/integrations

Assignees
No one assigned
Labels
Stale
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@davidbielik @utsabc @saikumarrs